<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!-- Copyright 1997 The Open Group, All Rights Reserved -->
<title>lpstat</title>
</head><body bgcolor=white>
<center>
<font size=2>
The Single UNIX &reg; Specification, Version 2<br>
Copyright &copy; 1997 The Open Group

</font></center><hr size=2 noshade>
<h4><a name = "tag_001_014_1270">&nbsp;</a>NAME</h4><blockquote>
lpstat - report printer status information (<b><a href="intro.html#tag_001_003_003">LEGACY</a></b>)
</blockquote><h4><a name = "tag_001_014_1271">&nbsp;</a>SYNOPSIS</h4><blockquote>
<pre><code>

lpstat <b>[</b>-drst<b>] [</b>-a<b>[</b><i>list</i><b>]] [</b>-c<b>[</b><i>list</i><b>]] [</b>-o<b>[</b><i>list</i><b>]] [</b>-p<b>[</b><i>list</i><b>]] [</b>-u<b>[</b><i>list</i><b>]]
[</b>-v<b>[</b><i>list</i><b>]] [</b><i>ID</i>...<b>]</b>
</code>
</pre>
</blockquote><h4><a name = "tag_001_014_1272">&nbsp;</a>DESCRIPTION</h4><blockquote>
The
<i>lpstat</i>
utility writes to standard output information about the current status
of the printer system.
<p>
If no
arguments
are given,
<i>lpstat</i>
writes the status of all requests made to
<i><a href="lp.html">lp</a></i>
by the user that are still in the output queue.
</blockquote><h4><a name = "tag_001_014_1273">&nbsp;</a>OPTIONS</h4><blockquote>
The
<i>lpstat</i>
utility supports the <b>XBD</b> specification, <a href="../xbd/utilconv.html#usg"><b>Utility Syntax Guidelines</b>&nbsp;</a> ,
except the option-arguments are optional and cannot be presented as separate
arguments.
<p>
Some of the options below can be followed
by an optional
<i>list</i>
that can be in one of two forms:
a list of items separated from one another by a comma,
or a quoted list of items
separated from one another by a comma or one or more
blank characters,
or combinations of both.
See the EXAMPLES section.
<p>
The omission of a
<i>list</i>
following such options causes all information
relevant to the option to be written to standard output; for example:
<pre>
<code>
lpstat -u
</code>
</pre>
<p>
writes the status of all output requests
that are still in the output queue.
<dl compact>

<dt><b>-a[</b><i>list</i><b>]</b><dd>Write the acceptance status
of destinations for output requests.
The
<i>list</i>
argument
is a list of intermixed printer names and class names.

<dt><b>-c[</b><i>list</i><b>]</b><dd>Write the class names and their members.
The
<i>list</i>
argument is a list of class names.

<dt><b>-d</b>
<dd>Write the system default destination for output requests.

<dt><b>-o[</b><i>list</i><b>]</b><dd>Write the status of output requests.
The
<i>list</i>
argument is a list of intermixed printer names, class names
and
<i>request ID</i>s.

<dt><b>-p[</b><i>list</i><b>]</b><dd>Write the status of printers.
The
<i>list</i>
argument is a list of printer names.

<dt><b>-r</b>
<dd>Write the status of the printer request scheduler.

<dt><b>-s</b>
<dd>Write a status summary, including the status of the printer scheduler,
the system default destination,
a list of class names and their members
and a list of printers and their associated devices.

<dt><b>-t</b>
<dd>Write all status information.

<dt><b>-u[</b><i>list</i><b>]</b><dd>Write the status of output requests for users.
The
<i>list</i>
argument is a list of login names.

<dt><b>-v[</b><i>list</i><b>]</b><dd>Write the names of printers and the pathnames of the devices
associated with them.
The
<i>list</i>
argument is a list of printer names.

</dl>
</blockquote><h4><a name = "tag_001_014_1274">&nbsp;</a>OPERANDS</h4><blockquote>
The following operand is supported:
<dl compact>

<dt><i>ID</i><dd>A
<i>request ID</i>,
as returned by
<i><a href="lp.html">lp</a></i>.

</dl>
</blockquote><h4><a name = "tag_001_014_1275">&nbsp;</a>STDIN</h4><blockquote>
Not used.
</blockquote><h4><a name = "tag_001_014_1276">&nbsp;</a>INPUT FILES</h4><blockquote>
None.
</blockquote><h4><a name = "tag_001_014_1277">&nbsp;</a>ENVIRONMENT VARIABLES</h4><blockquote>
The following environment variables affect the execution of
<i>lpstat</i>:
<dl compact>

<dt><i>LANG</i><dd>Provide a default value for the internationalisation variables
that are unset or null.
If
<i>LANG</i>
is unset or null, the corresponding value from the
implementation-dependent default locale will be used.
If any of the internationalisation variables contains an invalid setting, the
utility will behave as if none of the variables had been defined.

<dt><i>LC_ALL</i><dd>
If set to a non-empty string value,
override the values of all the other internationalisation variables.

<dt><i>LC_CTYPE</i><dd>
Determine the
locale for the interpretation of sequences of bytes of text data as
characters (for example, single- as opposed to multi-byte characters
in arguments).

<dt><i>LC_MESSAGES</i><dd>
Determine the locale that should be used to affect
the format and contents of diagnostic
messages written to standard error,
and informative messages written to standard output.

<dt><i>LC_TIME</i><dd>
Determine the format of date and time strings output
when displaying printer status information with the
<b>-a</b>,
<b>-o</b>,
<b>-p</b>,
<b>-t</b>
or
<b>-u</b>
options.

<dt><i>NLSPATH</i><dd>
Determine the location of message catalogues
for the processing of
<i>LC_MESSAGES .
</i>
<dt><i>TZ</i><dd>Determine the timezone used with date and time strings.

</dl>
</blockquote><h4><a name = "tag_001_014_1278">&nbsp;</a>ASYNCHRONOUS EVENTS</h4><blockquote>
Default.
</blockquote><h4><a name = "tag_001_014_1279">&nbsp;</a>STDOUT</h4><blockquote>
The standard output is a text file containing the information
described in the OPTIONS section, in an unspecified format.
</blockquote><h4><a name = "tag_001_014_1280">&nbsp;</a>STDERR</h4><blockquote>
Used only for diagnostic messages.
</blockquote><h4><a name = "tag_001_014_1281">&nbsp;</a>OUTPUT FILES</h4><blockquote>
None.
</blockquote><h4><a name = "tag_001_014_1282">&nbsp;</a>EXTENDED DESCRIPTION</h4><blockquote>
None.
</blockquote><h4><a name = "tag_001_014_1283">&nbsp;</a>EXIT STATUS</h4><blockquote>
The following exit values are returned:
<dl compact>

<dt>0<dd>Successful completion.

<dt>&gt;0<dd>An error occurred.

</dl>
</blockquote><h4><a name = "tag_001_014_1284">&nbsp;</a>CONSEQUENCES OF ERRORS</h4><blockquote>
Default.
</blockquote><h4><a name = "tag_001_014_1285">&nbsp;</a>APPLICATION USAGE</h4><blockquote>
The
<i>lpstat</i>
utility cannot reliably determine
the status of print requests in all conceivable circumstances.
When the printer is under the control of another
operating system or resides on a remote system
across a network, it need not be possible to
determine the status of the print job after it
has left the control of the local operating system.
Even on local printers, spooling hardware in the
printer may make it appear that the print job
has been completed long before the final page is printed.
</blockquote><h4><a name = "tag_001_014_1286">&nbsp;</a>EXAMPLES</h4><blockquote>
<ol>
<p>
<li>
Obtain the status of two printers,
the pathnames of two printers, a list of all class names
and the status of the request named
<b>HiPri-33</b>:
<pre>
<code>
lpstat -plaser1,laser4 -v"laser2 laser3" -c HiPri-33
</code>
</pre>
<p>
<li>
Obtain user print job status using the obsolescent
mixed blank and comma form:
<pre>
<code>
lpstat -u"ddg,gmv, maw" 
</code>
</pre>
<p>
</ol>
</blockquote><h4><a name = "tag_001_014_1287">&nbsp;</a>FUTURE DIRECTIONS</h4><blockquote>
A version of
<i>lpstat</i>
that fully supports the <b>XBD</b> specification, <a href="../xbd/utilconv.html#usg"><b>Utility Syntax Guidelines</b>&nbsp;</a>  may be
introduced in a future issue.
</blockquote><h4><a name = "tag_001_014_1288">&nbsp;</a>SEE ALSO</h4><blockquote>
<i><a href="cancel.html">cancel</a></i>,
<i><a href="lp.html">lp</a></i>.
</blockquote><hr size=2 noshade>
<center><font size=2>
UNIX &reg; is a registered Trademark of The Open Group.<br>
Copyright &copy; 1997 The Open Group
<br> [ <a href="../index.html">Main Index</a> | <a href="../xshix.html">XSH</a> | <a href="../xcuix.html">XCU</a> | <a href="../xbdix.html">XBD</a> | <a href="../cursesix.html">XCURSES</a> | <a href="../xnsix.html">XNS</a> ]

</font></center><hr size=2 noshade>
</body></html>
